Skip to content

docs(auth): update examples to use modular API #8327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
May 4, 2025
Merged

docs(auth): update examples to use modular API #8327

merged 5 commits into from
May 4, 2025

Conversation

DoctorJohn
Copy link
Contributor

Description

This PR updates the authentication docs to use the modular API.

I just finished migrating an app to the modular API and put my insights into this PR hoping the next person can benefit from it.

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan

I'll wait for the Vercel preview and then read the docs again. I already cross-checked the edits I made with my own code after the migration.

🔥

Think react-native-firebase is great? Please consider supporting the project with any of the below:

@vercel Vercel
Copy link

vercel bot commented Feb 13, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
react-native-firebase ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 1, 2025 7:39pm

@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from 8b0286b to db17815 Compare February 13, 2025 01:29
@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from db17815 to fa7de9b Compare February 20, 2025 17:39
@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from fa7de9b to f2782c2 Compare February 20, 2025 18:03
@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch 3 times, most recently from 7fb2af3 to 293999c Compare February 20, 2025 18:10
@github-actions GitHub Actions
Copy link

Hello 👋, this PR has been opened for more than 2 months with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 15 days until this gets closed automatically

@github-actions github-actions bot added the Stale label Mar 20, 2025
@DoctorJohn
Copy link
Contributor Author

Hi @mikehardy, IMHO the docs would still benefit from this PR. Thanks in advance for taking a look.

mikehardy
mikehardy requested changes Mar 21, 2025
View reviewed changes
Copy link
Collaborator

@mikehardy mikehardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm 🤔 These aren't quite right though...

  • currentUser is accessed as auth.currentUser on the return value of getAuth()
  • all methods should be patterned as methodName(getAuth(), <params>)

so there should never be an auth import, and there shouldn't be any getAuth().methodName()

The modular sections of the e2e test suites are the working examples at the moment

@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from 293999c to bb8d56f Compare March 28, 2025 19:21
@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from bb8d56f to e1ffd61 Compare March 28, 2025 20:06
@DoctorJohn
Copy link
Contributor Author

DoctorJohn commented Mar 28, 2025 •
edited
Loading

Thanks for the feedback, @mikehardy !

I just finished rewriting this PR and incorporated newly available imports added with recently merged PRs (i.e. the auth providers are now importable).

so there should never be an auth import, and there shouldn't be any getAuth().methodName()

Unfortunately, the auth module import is not quite gone yet since PhoneMultiFactorGenerator cannot be imported via the modular API (yet?). To avoid confusion with Auth instances returned by getAuth(), I named the auth module imports authModule in the examples (i.e. authModule.PhoneMultiFactorGenerator is still used in the multi factor auth docs).

Similarly, revokeToken, verifyPhoneNumberForMultiFactor, and verifyPhoneNumberWithMultiFactorInfo are currently only available on Auth instances and cannot be imported individually via the modular API yet. As a result the docs still contain examples like this auth.revokeToken("...") instead of revokeToken(auth, "...").

@DoctorJohn DoctorJohn requested a review from mikehardy April 7, 2025 18:44
mikehardy
mikehardy requested changes Apr 28, 2025
View reviewed changes
Copy link
Collaborator

@mikehardy mikehardy left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getting closer - sorry for the delay on review - but still documents a partial transition

I think a lot of the issues are easily fixed with current implementation and need to be fixed

There may be (likely is?) an implementation gap on the multi-factor stuff where we simply don't have the right APIs yet - either not exposing the MFA types for direct import yet or missing a method completely. I think these may be somewhat easy to fix in fact, and if they are missing I'd like to collaborate in fixing while getting this PR in

deprecating auth.currentUser and removing it is a breaking change so that is out of scope but documenting to access the user off credential or via getAdditionalUserInfo is important I think so people use the correct style going forward [edit: turns out <Auth>.currentUser is still valid, I've modified all related comments below - no issue here with using .currentUser

@mikehardy mikehardy added Workflow: Waiting for User Response Blocked waiting for user response. plugin: authentication Firebase Authentication impact: web-implementation An API in RNFB does not conform to the Firebase Web SDK labels Apr 28, 2025
@mikehardy mikehardy mentioned this pull request Apr 28, 2025
Merged
9 tasks
@DoctorJohn DoctorJohn force-pushed the update-auth-docs-to-use-modular-api branch from e1ffd61 to 0566373 Compare May 1, 2025 16:24
@DoctorJohn DoctorJohn mentioned this pull request May 1, 2025
Merged
9 tasks
mikehardy
mikehardy approved these changes May 1, 2025
View reviewed changes
Copy link
Collaborator

@mikehardy mikehardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool - thanks for doing this. I think documentation is easily as hard as code, and then when it's got code in it, doing it right is that much harder. This will be a big help for people

@mikehardy
Copy link
Collaborator

Lemme pull this locally and do the mindless lint / formatting stuff, it's all auto for me and I want to get this in

@mikehardy mikehardy added Workflow: Pending Merge Waiting on CI or similar and removed Workflow: Waiting for User Response Blocked waiting for user response. Needs Attention labels May 1, 2025
@DoctorJohn
Copy link
Contributor Author

Very cool - thanks for doing this. I think documentation is easily as hard as code, and then when it's got code in it, doing it right is that much harder. This will be a big help for people

For me, the scary part about docs is that tests usually don't catch errors/bugs in the code samples. I'm co-maintaining a quite popular Python project where we face the same issue. Someone recently opened a PR that adds tests to our CI checking whether code samples in the docs are self-contained and can be run as-is. Turns out most of our code samples are not self-contained, and we need a lot of extra work before we could potentially merge that PR.

Lemme pull this locally and do the mindless lint / formatting stuff, it's all auto for me and I want to get this in

No way I forgot to lint/format the docs again haha. I'm too spoiled by pre-commit hooks.

@mikehardy mikehardy merged commit 484b04c into invertase:main May 4, 2025
8 checks passed
@mikehardy
Copy link
Collaborator

just released the underlying code with the PR that makes this possible, so, good to go on the docs merge. Thanks again

@DoctorJohn DoctorJohn mentioned this pull request May 4, 2025
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikehardy mikehardy mikehardy approved these changes

Assignees
No one assigned
Labels
impact: web-implementation An API in RNFB does not conform to the Firebase Web SDK plugin: authentication Firebase Authentication
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DoctorJohn @mikehardy